home *** CD-ROM | disk | FTP | other *** search
/ ftp.ncftp.com / ftp.ncftp.com.zip / ftp.ncftp.com / ncftp / binaries / Setup NcFTP 3.2.5.msi / _C8DEB57094A6B44B059F9B6C123BB40F / _BFEE83962FCA47F1B67EE272B46C5DDB < prev    next >
Text File  |  2010-04-06  |  11KB  |  298 lines

  1. <HTML>
  2. <HEAD>
  3. <TITLE>ncftpget(1) manual page</TITLE>
  4. </HEAD>
  5. <BODY bgcolor=white>
  6.  
  7. <H2>Name</H2>
  8. <blockquote>
  9.   <b>
  10. ncftpget</b> - Internet file transfer program for scripts
  11. </blockquote>
  12. <H2>Synopsis</H2>
  13. <blockquote>
  14. <P><B>ncftpget</B> [<I>options</I>] <I>remote-host</I> <i>local-directory</i> <i>remote-files...</i></p>
  15. <P><B>ncftpget</B> [<I>options</I>] <I>bookmark-name</I> <i>local-directory</i> <i>remote-files...</i></p>
  16. <P><B>ncftpget</B> <tt>-f</tt> login.cfg [<I>options</I>] <I>local-directory</I>  <i>remote-files...</i></p>
  17. <P><B>ncftpget</B> [<I>options</I>] <I>ftp://url.style.host/path/name</I></p>
  18. <P><B>ncftpget</B> <tt>-c</tt> [<I>options</I>] <I>remote-host</I> <i>remote-file</i><tt> > stdout</tt></p>
  19. <P><B>ncftpget</B> <tt>-C</tt> [<I>options</I>] <I>remote-host</I> <i>remote-file</i> <i>local-path-name</i></p>
  20. <P><B>ncftpget</B> <tt>-c</tt> [<I>options</I>] <I>ftp://url.style.host/path/name</I><tt> > stdout</tt></p>
  21.  
  22. </blockquote>
  23.  
  24. <center>
  25. <p>
  26. <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
  27. <input type="hidden" name="cmd" value="_xclick">
  28. <input type="hidden" name="business" value="sales@ncftp.com">
  29. <input type="hidden" name="item_name" value="NcFTP Client">
  30. <input type="hidden" name="item_number" value="NcFTP">
  31. <input type="hidden" name="no_shipping" value="2">
  32. <input type="hidden" name="no_note" value="1">
  33. <input type="hidden" name="currency_code" value="USD">
  34. <input type="hidden" name="tax" value="0">
  35. <input type="hidden" name="bn" value="PP-DonationsBF">
  36. <input type="image" src="https://www.paypal.com/en_US/i/btn/x-click-butcc-donate.gif" border="0" name="submit" alt="Make a donation!">
  37. <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
  38. </form>
  39. </center>
  40.  
  41. <H2>Options</H2>
  42.  Command line flags:
  43. <blockquote>
  44. <DL>
  45.  
  46. <DT><B>-u </B><I>XX</I> </DT>
  47. <DD>Use username <I>XX</I> instead of anonymous.
  48. </DD>
  49.  
  50. <DT><B>-p </B><I>XX</I> </DT>
  51. <DD>Use password <I>XX</I> with the username. </DD>
  52.  
  53. <DT><B>-P </B><I>XX</I> </DT>
  54. <DD>Use port number <I>XX</I> instead
  55. of the default FTP service port (21). </DD>
  56.  
  57. <DT><B>-j </B><I>XX</I> </DT>
  58. <DD>Use account <I>XX</I> in supplement
  59. to the username and password (deprecated). </DD>
  60.  
  61. <DT><B>-d </B><I>XX</I> </DT>
  62. <DD>Use the file <I>XX</I> for debug
  63. logging. </DD>
  64.  
  65. <DT><B>-a</B> </DT>
  66. <DD>Use ASCII transfer type instead of binary. </DD>
  67.  
  68. <DT><B>-t </B><I>XX</I> </DT>
  69. <DD>Timeout after
  70. <I>XX</I> seconds. </DD>
  71.  
  72. <DT><B>-v</B>/<B>-V</B> </DT>
  73. <DD>Do (do not) use progress meters. The default is to use progress
  74. meters if the output stream is a TTY. </DD>
  75.  
  76. <DT><B>-f </B><I>XX</I> </DT>
  77. <DD>Read the file <I>XX</I> for host, user,
  78. and password information. </DD>
  79.  
  80. <DT><B>-c</B> </DT>
  81. <DD>Read from remote host and write locally to standard out.</DD>
  82.  
  83. <DT><B>-C</B> </DT>
  84. <DD>Read from remote host and write locally to specified pathname.</DD>
  85.  
  86. <DT><B>-A</B> </DT>
  87. <DD>Append to local files, instead of overwriting
  88. them. </DD>
  89.  
  90. <DT><B>-z</B>/<B>-Z</B> </DT>
  91. <DD>Do (do not) try to resume transfers. The default is to try to resume
  92. (-z). </DD>
  93.  
  94. <DT><B>-E</B> </DT>
  95. <DD>Use regular (PORT) data connections. </DD>
  96.  
  97. <DT><B>-F</B> </DT>
  98. <DD>Use passive (PASV) data connections.  The default is to use passive, but to fallback to
  99.   regular if the passive connection fails or times out. </DD>
  100.  
  101. <DT><B>-DD</B> </DT>
  102. <DD>Delete remote file after successfully
  103. downloading it. </DD>
  104.  
  105. <DT><B>-R</B> </DT>
  106. <DD>Recursive mode; copy whole directory trees. </DD>
  107.  
  108. <DT><B>-T</B> </DT>
  109. <DD>Do not use automatic on-the-fly TAR mode for downloading whole directory trees. 
  110.   The program uses TAR whenever possible since this usually preserves symbolic links
  111.   and file permissions. TAR mode can also result in faster transfers for directories containing many
  112.   small files, since a single data connection can be used rather than an FTP
  113.   data connection for each small file. The downside to using TAR is that it forces downloading of the whole directory,
  114.   even if you had previously downloaded a portion of it earlier, so you may want to use this option if you want to resume downloading of a directory. </DD>
  115.  
  116. <DT><B>-r </B><I>XX</I> </DT>
  117. <DD>Redial
  118. a maximum of <I>XX</I> times until connected to the remote FTP server. </DD>
  119.  
  120. <DT><B>-b</B> </DT>
  121. <DD>Run in
  122. background (by submitting a job to <I>ncftpbatch</I>). </DD>
  123.  
  124. <DT><B>-bb</B> </DT>
  125. <DD>
  126. Similar to <b>-b</b> option, but only submits the batch
  127. job. You will need to run <i>ncftpbatch</i> for the
  128. batch job to be processed. This is useful if you
  129. already have a <i>ncftpbatch</i> process running, or wish
  130. to have better control of when batch jobs are processed.
  131. <P>
  132. For example, if you wanted to do background processing
  133. of three files all on the same remote
  134. server, it is more polite to use just one <i>ncftpbatch</i>
  135. process to process the three jobs sequentially,
  136. rather than having three <i>ncftpbatch</i> processes open
  137. three simultaneous FTP sessions to the same server.
  138. </DD>
  139.  
  140. <DT><B>-B </B><I>XX</I> </DT>
  141. <DD>Try setting the TCP/IP
  142. socket buffer size to <I>XX</I> bytes.  </DD>
  143. </DL>
  144.  
  145. <DT><B>-W </B><I>XX</I> </DT>
  146. <DD>Send raw FTP command <I>XX</I> after logging in.</DD>
  147.  
  148. <DT><B>-X </B><I>XX</I> </DT>
  149. <DD>Send raw FTP command <I>XX</I> after each file transferred.</DD>
  150.  
  151. <DT><B>-Y </B><I>XX</I> </DT>
  152. <DD>
  153. Send raw FTP command <I>XX</I> before logging out.
  154. <P>
  155. The <B>-W</B>, <B>-X</B>, and <B>-Y</B> options are useful for advanced
  156. users  who need to tweak behavior on some servers.
  157. For example, users accessing mainframes might need
  158. to  send  some special SITE commands to set blocksize
  159. and record format information.
  160. <P>
  161. For these options, you can use them multiple times
  162. each if you need to send multiple commands.
  163. For the
  164. <B>-X</B> option, you can use the  cookie <TT>%s</TT>  to  expand
  165. into the name of the file that was transferred.
  166. </DD>
  167.  
  168. <DT><B>-o </B><I>XX</I> </DT>
  169. <DD>Set advanced option <I>XX</I>.
  170. <P>
  171. This option is used primarily for debugging.
  172. It sets the value of an internal variable to an integer value.
  173. An example usage would be:
  174. <tt>-o useFEAT=0,useCLNT=1</tt>
  175. which in this case, disables use of the
  176. FEAT command and enables use of the CLNT command.
  177. The available variables include:
  178. <tt>usePASV</tt>,
  179. <tt>useSIZE</tt>,
  180. <tt>useMDTM</tt>,
  181. <tt>useREST</tt>,
  182. <tt>useNLST_a</tt>,
  183. <tt>useNLST_d</tt>,
  184. <tt>useFEAT</tt>,
  185. <tt>useMLSD</tt>,
  186. <tt>useMLST</tt>,
  187. <tt>useCLNT</tt>,
  188. <tt>useHELP_SITE</tt>,
  189. <tt>useSITE_UTIME</tt>,
  190. <tt>STATfileParamWorks</tt>,
  191. <tt>NLSTfileParamWorks</tt>,
  192. <tt>require20</tt>,
  193. <tt>allowProxyForPORT</tt>,
  194. <tt>doNotGetStartCWD</tt>.
  195. </DD>
  196.  
  197. </blockquote>
  198.  
  199. <H2>Description</H2>
  200.  <P>
  201. The purpose of <I>ncftpget</I> is
  202. to do file transfers from the command-line without entering an interactive
  203. shell. This lets you write shell scripts or other unattended processes that
  204. can do FTP. It is also useful for advanced users who want to retrieve files
  205. from the shell command line without entering an interactive FTP program
  206. such as <I>ncftp</I>. <P>
  207. One particularly useful feature of this program is that you
  208. can give it a <I>uniform</I> resource locator as the only argument and the program
  209. will download that file. You can then copy and paste from your web browser
  210. or newsreader and use that URL. Example: <blockquote><pre>$ cd /tmp
  211. $ ncftpget ftp://ftp.ncftp.com/pub/ncftp/ncftp.tar.Z
  212. $ zcat ncftp.tar.Z | tar xf -</pre>
  213. </blockquote>
  214. <P>
  215. By default the program tries to open the remote host and login anonymously,
  216. but you can specify a username and password information. The <B>-u</B> option is
  217. used to specify the username to login as, and the <B>-p</B> option is used to specify
  218. the password. If you are running the program from the shell, you may omit
  219. the <B>-p</B> option and the program will prompt you for the password. <P>
  220. Using the
  221.  <B>-u</B> and <B>-p</B> options are not recommended, because your account information
  222. is exposed to anyone who can see your shell script or your process information.
  223.  For example, someone using the <I>ps</I> program could see your password while
  224. the program runs. <P>
  225. You may use the <B>-f</B> option instead to specify a file with
  226. the account information. However, this is still not secure because anyone
  227. who has read access to the information file can see the account information.
  228. Nevertheless, if you choose to use the <B>-f</B> option the file should look something
  229. like this: <blockquote><pre>host sphygmomanometer.ncftp.com
  230. user gleason
  231. pass mypasswd</pre>
  232. </blockquote>
  233. <p>
  234. Don't forget to change the permissions on this file so no one else can read
  235. them.</p>
  236.  <P>
  237. The <B>-d</B> option is very useful when you are trying to diagnose why a
  238. file transfer is failing. It prints out the entire FTP conversation to the
  239. file you specify, so you can get an idea of what went wrong.   If you specify
  240. the special name <I>stdout</I> as the name of the debugging output file, the output
  241. will instead print to the screen.  Example: <blockquote><pre>$ ncftpget -d stdout bowser.nintendo.co.jp . /pub/ncftp/README
  242. 220: FTP server ready.
  243. Connected to bowser.nintendo.co.jp.
  244. Cmd: USER anonymous
  245. 331: Guest login ok, send your complete e-mail address as password.
  246. Cmd: PASS xxxxxxxx
  247. 230: Welcome!
  248. Logged in to bowser.nintendo.co.jp as anonymous.
  249. Cmd: TYPE I
  250. 200: Type set to I.
  251. Cmd: PORT 192,168,9,37,6,76
  252. 200: PORT command successful.
  253. Cmd: RETR /pub/README
  254. 550: /pub/README: File in use.
  255. Cmd: QUIT
  256. 221: Goodbye.</pre>
  257. </blockquote>
  258. <P>
  259. Using ASCII mode is helpful when the text format of your host differs from
  260. that of the remote host. For example, if you are retrieving a .TXT file from
  261. a Windows-based host to a UNIX system, you could use the <B>-a</B> flag which would
  262. use ASCII transfer mode so that the file created on the UNIX system would
  263. be in the UNIX text format instead of the MS-DOS text format. <P>
  264. You can retrieve
  265. an entire directory tree of files by using the <B>-R</B> flag. However, this will
  266. work only if the remote FTP server is a UNIX server, or emulates UNIX's
  267. list output. Example: <blockquote><pre>$ ncftpget -R ftp.ncftp.com /tmp /pub/ncftp</pre>
  268. </blockquote>
  269. <p>This would create a /tmp/ncftp hierarchy.</p>
  270. <H2>Diagnostics</H2>
  271. <blockquote>
  272.  <P>
  273. <I>ncftpget</I> returns
  274. the following exit values: 
  275. <OL start="0">
  276. <LI>Success. </LI><LI>Could not connect to remote host. </LI><LI>Could
  277. not connect to remote host - timed out. </LI><LI>Transfer failed. </LI><LI>Transfer failed -
  278. timed out. </LI><LI>Directory change failed. </LI><LI>Directory change failed - timed out. </LI><LI>Malformed
  279. URL. </LI><LI>Usage error. </LI><LI>Error in login configuration file. </LI><LI>Library initialization
  280. failed. </LI><LI>Session initialization failed.  </LI>
  281. </OL>
  282.  
  283. </blockquote>
  284.  
  285. <H2>Author</H2>
  286. <blockquote>
  287.  <P>
  288. Mike Gleason, <a href="http://www.ncftp.com">NcFTP Software</a>.
  289. </blockquote>
  290. <H2>See Also</H2>
  291. <blockquote>
  292.  <P>
  293. <I>ncftpput(1)</I>, <I>ncftpget(1),</I>
  294. <I>ncftp(1)</I>, <I>ftp(1)</I>, <I>rcp(1)</I>, <I>tftp(1)</I>. <P>
  295. <I>LibNcFTP</I>  (<a href="http://www.ncftp.com/libncftp/">http://www.ncftp.com/libncftp/</a>).
  296. </blockquote>
  297. </BODY></HTML>
  298.